Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Moved lesson order. #263

Merged

Conversation

reid-a
Copy link
Contributor

@reid-a reid-a commented Feb 2, 2021

Lesson order is now specified in the site-specific _config_options.yml file. Updated the top-level README to reflect this. Did not actually re-order the lessons.

Closes #230.

Lesson order is now specified in the site-specific
_config_options.yml file.  Updated the top-level README
to reflect this.
Copy link
Contributor

@tkphd tkphd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please terminate files with a newline character.

Copy link
Contributor

@tkphd tkphd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks pretty good! Thanks for propagating throughout the snippet library.
My feeling is that episode_names should also be defined in the top-level _config.yml. Do you have a reason not to place it there?

@reid-a
Copy link
Contributor Author

reid-a commented Feb 2, 2021

The top-level behavior is to run through the entire contents of _episodes in lexical order, I think, which is a reasonable default, but making it explicit probably improves legibility. The downside is that it's yet another place where the file-names are hard-coded.

On balance, I favor this, and have now done it.

@tkphd
Copy link
Contributor

tkphd commented Feb 2, 2021

Yeah... I prefer having the episode order defined explicitly at the top, then we can document changes. When the site builds on GitHub, it only uses what's in _config.yml, but local copies -- and those on GitLab, which provides a config file for the build system -- can use HPC_JEKYLL_CONFIG to override the top-level settings. If a site's snippet config defines a different order (like CTCMS dropping the modules lesson), those local changes are kept. Otherwise, default; or, as is currently the case, every snippet lib also explicitly defines lesson order.

@reid-a reid-a merged commit 6f8b6f6 into carpentries-incubator:gh-pages Feb 2, 2021
@reid-a reid-a deleted the issue-230-non-sequential-lessons branch February 2, 2021 04:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Introduce non-sequential lesson numbering
2 participants